NAME¶

pmiPutMark - write a <mark> record to a PCP archive

C SYNOPSIS¶

#include <pcp/pmapi.h>
#include <pcp/import.h>

int pmiPutMark(void);

cc ... -lpcp_import -lpcp

Perl SYNOPSIS¶

use PCP::LogImport;

pmiPutMark();

DESCRIPTION¶

As part of the Performance Co-Pilot Log Import API (see LOGIMPORT(3)), pmiPutMark writes a <mark> record to the current PCP output archive. This is required when there is a temporal discontinuity between the current input source and the next input source, if any, and should be called after the final call to pmiWrite(3) for the current input. If there is no next input to be processed or no temporal gap between sources, then the <mark> record is not required.

The <mark> record is used to signify a temporal gap, so that when replaying the output PCP archive, interpolation of metric values should not be performed between the last timestamp in the current input source to the first timestamp in the next input source, i.e. across the <mark> record.

DIAGNOSTICS¶

pmiPutMark returns zero on success else a negative value that can be turned into an error message by calling pmiErrStr(3).

SEE ALSO¶

LOGIMPORT(3), pmiAddInstance(3), pmiAddMetric(3), pmiErrStr(3), pmiPutResult(3), pmiPutValue(3), pmiPutValueHandle(3), pmiPutText(3), pmiPutLabel(3) and pmiWrite(3).